<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../../" />
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>
		[page:Object3D] &rarr; [page:Line] &rarr;

		<h1>[name]</h1>

		<p class="desc">
			Renders [page:ArrowHelper arrows] to visualize an object's vertex normal vectors.
			Requires that normals have been specified in a [page:BufferAttribute custom attribute] or
			have been calculated using [page:BufferGeometry.computeVertexNormals computeVertexNormals].<br /><br />
		</p>

		<h2>Code Example</h2>

		<code>
		const geometry = new THREE.BoxGeometry( 10, 10, 10, 2, 2, 2 );
		const material = new THREE.MeshBasicMaterial( { color: 0xff0000 } );
		const box = new THREE.Mesh( geometry, material );

		const helper = new VertexNormalsHelper( box, 2, 0x00ff00, 1 );

		scene.add( box );
		scene.add( helper );
		</code>

		<h2>Examples</h2>
		<p>
			[example:webgl_helpers WebGL / helpers]
		</p>

		<h2>Constructor</h2>


		<h3>[name]( [param:Object3D object], [param:Number size], [param:Hex color], [param:Number linewidth] )</h3>
		<p>
			[page:Object3D object] -- object for which to render vertex normals.<br />
			[page:Number size] -- (optional) length of the arrows. Default is 1.<br />
			[page:Hex color] -- hex color of the arrows. Default is 0xff0000.<br />
			[page:Number linewidth] -- (optional) width of the arrow lines. Default is 1.
		</p>


		<h2>Properties</h2>
		<p>See the base [page:LineSegments] class for common properties.</p>

		<h3>[property:Object matrixAutoUpdate]</h3>
		<p>
			See [page:Object3D.matrixAutoUpdate]. Set to *false* here as the helper is using the
			object's [page:Object3D.matrixWorld matrixWorld].
		</p>

		<h3>[property:Object3D object]</h3>
		<p>The object for which the vertex normals are being visualized.</p>

		<h3>[property:Number size]</h3>
		<p>Length of the arrows. Default is *1*.</p>


		<h2>Methods</h2>
		<p>See the base [page:LineSegments] class for common methods.</p>


		<h3>[method:null update]()</h3>
		<p>Updates the vertex normal preview based on movement of the object.</p>


		<h2>Source</h2>

		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/VertexNormalsHelper.js examples/jsm/helpers/VertexNormalsHelper.js]
		</p>
	</body>
</html>
